home *** CD-ROM | disk | FTP | other *** search
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- CODELISTER
-
- --------------------------------------------------------------
-
-
-
-
-
-
- USER'S MANUAL
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- MALCOLM MCDOWELL
- 85 Halley St
- Nepean Ontario
- K2J 3R5
-
- (613) 825-8593
-
-
- .
-
-
-
- WARRANTY
-
- Users of "CodeLister" must accept this disclaimer of warranty:
- "CodeLister" is supplied as is. The author disclaims all
- warranties, expressed or implied, including, without limitation,
- the warranties of merchantability and of fitness for any purpose.
- The author assumes no liability for damages, direct or conse-
- quential, which may result from the use of "CodeLister."
-
-
- USE RESTRICTIONS
-
-
- CodeLister is a "shareware program" and is provided at no charge
- to the user for evaluation. Feel free to share it with your
- friends, but please do not give it away altered or as part of
- another system. The essence of "user-supported" software is to
- provide personal computer users with quality software without
- high prices, and yet to provide incentive for programmers to
- continue to develop new products. If you find this program
- useful and find that you are using CodeLister and continue to use
- CodeLister after a reasonable trial period, you must make a
- registration payment of $20.00 + Shipping and Handling (Canadian
- dollars) to Malcolm McDowell. The $20.00 registration fee will
- license one copy for use on any one computer at any one time.
-
- Commercial users of CodeLister must register and pay for their
- copies of CodeLister within 30 days of first use or their license
- is withdrawn. Site-License arrangements may be made by
- contacting Malcolm McDowell.
-
- Anyone distributing CodeLister for any kind of remuneration must
- first contact Malcolm McDowell at the address below for
- authorization.
-
- This authorization will be automatically granted to distributors
- recognized by the (ASP) as adhering to its guidelines for
- shareware distributors, and such distributors may begin offering
- CODELISTER immediately (However Malcolm McDowell must still be
- advised so that the distributor can be kept up-to-date with the
- latest version of CodeLister.).
-
- You are encouraged to pass a copy of CodeLister along to your
- friends for evaluation. Please encourage them to register their
- copy if they find that they can use it. All registered users
- will receive a copy of the latest version of the CodeLister
- package.
-
-
- OMBUDSMAN NOTICE
-
-
-
-
-
-
-
-
-
- This program is produced by a member of the Association of
- Software Professionals (ASP). ASP wants to make sure that the
- shareware principle works for you. If you are unable to resolve a
- shareware-related problem with an ASP member by contacting the
- member directly, ASP may be able to help. The ASP Ombudsman can
- help you resolve a dispute or problem with an ASP member, but
- does not provide technical support for members' products. Please
- write to the ASP Ombudsman at 545 Grover Road, Muskegon, MI 49442
- or send a CompuServe message via CompuServe Main to ASP Ombudsman
- 70007,3536.
-
-
-
-
- TABLE OF CONTENTS
-
- CHAPTER 1 INTRODUCTION. . . . . . . . . . . . . . . . . . . . . . . . . 1
-
- 1.1 SYSTEM REQUIREMENTS . . . . . . . . . . . . . . . . . . . . . . 1
- 1.2 FEATURES. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
-
- CHAPTER 2 INSTALLATION. . . . . . . . . . . . . . . . . . . . . . . . . 3
-
- CHAPTER 3 RUNNING CODELISTER. . . . . . . . . . . . . . . . . . . . . . 4
-
- 3.1 Command Line Parameters. . . . . . . . . . . . . . . . . . . . 4
- 3.1.1 Printing Individual Files. . . . . . . . . . . . . . . . 4
- 3.1.2 Printing Project Files.. . . . . . . . . . . . . . . . . 4
- 3.1.2.1 Project File Extension. . . . . . . . . . . . . . 5
- 3.1.2.2 Creating Project Files. . . . . . . . . . . . . . 5
- 3.2 Definition of CodeLister Display.. . . . . . . . . . . . . . . 7
- 3.2.1 F1 - Set Configuration.. . . . . . . . . . . . . . . . . 8
- 3.2.1.1 Description of Configuration
- Parameters.. . . . . . . . . . . . . . . . . . . . . 8
- 3.2.2 F2 - Continue. . . . . . . . . . . . . . . . . . . . . . 11
- 3.2.2.1 Display of Files Printed. . . . . . . . . . . . . 11
- 3.2.2.2 Stopping the Printing of Files. . . . . . . . . . 11
- 3.2.3 F10 - Stop. . . . . . . . . . . . . . . . . . . . . . . 11
-
- CHAPTER 4 DEFINITION OF LISTINGS. . . . . . . . . . . . . . . . . . . . 12
-
- CHAPTER 5 ERROR MESSAGES. . . . . . . . . . . . . . . . . . . . . . . . 13
-
- CHAPTER 6 REGISTRATION. . . . . . . . . . . . . . . . . . . . . . . . . 14
-
- CHAPTER 1 INTRODUCTION
-
-
-
-
- 1.1 SYSTEM REQUIREMENTS
-
- CodeLister is designed to run on DOS 4.00 or higher. A VGA
- monitor is recommended. The printers supported include standard
- graphics printers such as:
-
- EPSON
- ROLAND
-
- and laser printers such as:
-
- HP LASERJET II
- HP LASERJET III.
-
-
- 1.2 FEATURES
-
- CodeLister is a package used to support source code development
- and configuration management. Its features include:
-
- o Formatted C source code printouts.
-
- CodeLister will take individual source files or
- project files and format them for printing. This
- prevents lines of text being printed on the
- perforations or off the page.
-
- o Each page is identified with a header.
-
- The header contains the file name, the date that
- the file was edited and saved and the page number.
- This allows you to identify printouts belonging to
- a given date and configuration.
-
- o Multiple Pages on a single sheet of paper.
-
- If you are using a laser printer, CodeLister can
- generate listings that have one, two or four pages
- on each sheet of paper. This is ideal for storing
- old listings and saving paper.
-
- - 1 -
-
- o Table of Contents.
-
- A Table of Contents lists the functions and the
- page in the listing where it is defined. This
- allows you to quickly locate a function in the
- listing or as a quick reference to function
- parameters.
-
- o Statistics
-
- The number of lines of code and the size in bytes
- of the ASCII files.
-
- - 2 -
-
- CHAPTER 2 INSTALLATION
-
-
-
-
- To setup CodeLister perform the following steps:
-
- 1) CLIST.ZIP is a self-extracting file. Extract the files by
- typing:
-
- CLIST
-
- at the DOS prompt.
-
- 2) A number of files will extracted. Refer to packing.lst for a
- description of the files. The install.bat can be used to
- install CodeLister. It assumes that you have a hard disk, or
- c: drive. To continue, make sure that you are in the
- directory or on the drive (ie a: or b:) containing the
- install.bat file. To continue with the installation, type:
-
- INSTALL
-
- The installation will create a directory called C:\CLIST and
- copy the files:
-
- CLIST.EXE and
- CLIST.CFG
-
- to the directory.
-
-
- 3) Add the directory to your path name. Use your editor to add
- the path to autoexec.bat file. This is done by adding:
-
- ;c:\clist
-
- to the line that has "PATH=" in your autoexec.bat file.
-
- Your are now ready to execute CodeLister from any directory on
- your computer.
-
-
- NOTE:
-
- CodeLister will create a configuration file from each
- directory that you execute it from.
-
- - 3 -
-
-
- CHAPTER 3 RUNNING CODELISTER
-
-
-
-
- The section describes how to run CodeLister. This version of
- CodeLister will create a configuration file in each directory
- that it is run from.
-
- 3.1 Command Line Parameters.
-
- To run CodeLister one of two command line parameters must be
- specified. One command line parameter is to tell CodeLister
- that the file to print is an single "c" source file and the
- other is to print a project file, which contains a list of
- "c" files.
-
-
- 3.1.1 Printing Individual Files.
-
-
- A single source file is printed by typing the following at
- the DOS prompt:
-
- > clist filename
-
- or
-
- > clist filename.c
-
-
- 3.1.2 Printing Project Files.
-
- CodeLister accepts project files as input. A PROJECT FILE is
- defined as a file containing a list of source code files that are
- to be formatted and printed.
-
- When a project file is used to print your source code, page
- number 1 starts with the first file and page numbers will
- continue sequentially until the last source file is printed. The
- Table of Contents includes all functions in the project file.
- Statistics printed will include the total number of lines and
- size, in bytes, for all files defined in the project file.
-
- A project file is printed by typing the following at the DOS
- prompt:
-
- - 4 -
-
-
- > clist -p project
-
- or
-
- > clist -p project.fil
-
- To differentiate between a source file and a project file, the -p
- command line entry is typed before the project file name is
- entered.
-
- Make sure that you leave a space between the -p and the
- project file name.
-
- The project file extension is assumed to be .prj, if no extension
- is provided.
-
- 3.1.2.1 Project File Extension.
-
- CodeLister will assume that the project file has a .PRJ
- extension, but any extension can be used provided that it is
- entered on the command line with the extension such as:
-
- clist -p project.fil
-
-
- 3.1.2.2 Creating Project Files.
-
- To create a project file edit a file that contains all of your C
- source code. Example project files are shown:
-
- main.c
- function1.c
- function2.c
- function3.c
- function1.h
- function2.h
-
-
- or
-
- main
- function1
- function2
- function3
- function1.h
- function2.h
-
- Note that some file names exclude the ".c" extension. All files without the extension are assumed to be a .c file. If the file to
- be printed, is a ".h" file, make sure the ".h" extension is
- included in the file name. This is especially important when a
- file name has both a ".c" and ".h" extension. For example:
-
- function1.c and function2.h
-
- - 5 -
-
- 3.2 Definition of CodeLister Display.
-
- If CodeLister has a valid configuration file, the default
- parameters are displayed, informing you of the type of printout
- that will be performed. If a configuration file is not found,
- then CodeLister will automatically prompt you for the information
- as defined in section 3.2.1.1. Otherwise, CodeLister will show
- the information in the following display:
-
- ============================================================================
-
- Current Configuration
-
- Printer Type - GRAPHICS
- Page Format - Single Page
- Character Style - Normal
- Printer Port - lpt1
- Border - YES
- Table of Contents - YES
- Statistics - YES
-
- CodeLister will print source file: test
-
-
-
-
-
-
- ---------------------------------------------------------------------------
- F1 - Set Configuration F2 - Continue F10 - Exit
-
- ===========================================================================
- The prompt:
-
- CodeLister will print source file: test
-
- indicates the file that you requested to be printed. When
- CodeLister detects a project file the prompt will be:
-
- CodeLister will print project file: project
-
- The menu at the bottom defines the function keys that can be used
- to activate functions. Refer to section 3.2.1 for function key F1
- and section 3.2.2 for function key F2 .
-
- - 6 -
-
- 3.2.1 F1 - Set Configuration.
-
- This section describes the initialization of the CodeLister
- configuration parameters. If CodeLister does not have a valid
- configuration file, or you wish to change the configuration, by
- selecting F1 - Set Configuration the series of prompts, listed in
- section 3.2.1.1, is displayed.
-
- Valid parameters are listed in each prompt between the brackets,
- [ and ]. Using the example prompt,
-
- Enter value [ 1 or 2 ] ?
-
- the valid parameters are [ 1 or 2 ], so you can enter either 1 or
- 2. If an error is made you will hear a beep and the error message
- Invalid Entry will be displayed, momentarily, on the lower line
- of the screen. If this occurs edit the parameter to match one of
- those in the brackets.
-
- The default parameters are displayed after the question mark (?).
- In the example prompt:
-
- Enter value [ 1 or 2 ] ? 1
-
- The value 1 following the ? is the default parameter. The
- default parameters are obtained from your configuration file. To
- change a parameter, you can use the DEL and Backspace key and
- type the appropriate entry. To accept the default parameter,
- simply press ENTER.
-
- 3.2.1.1 Description of Configuration Parameters.
-
- This section describes the series of prompts used to select the
- configuration. These include the printer type, the printer port
- and the format of the output. These parameters allow CodeLister
- to communicate with the appropriate printer and provide the
- output suitable to your needs.
-
- You will see the following display:
-
- CodeLister Setup
-
- Select Printer Type...
-
- [1] Standard graphics printer
- [2] Laser printer
-
- Make selection [1 or 2] ? 1
- - 7 -
- Standard graphics printers that have been tested
- include:
-
- 1) EPSON and ROLAND or
-
- Laser printers that have been tested including:
-
- 2) HP LaserJet III.
-
- If you are using a standard graphics printer, enter 1.
- If you are using a Laser printer enter 2. The default
- is 1 or Standard Graphics Printer.
-
- Select Character Style ...
-
- [1] Normal.
- [2] Compressed.
-
- Make selection [1 or 2] ? 1
-
- If Compressed style is selected, more characters are
- printed in a line.
-
- The select page format prompt is only displayed if you
- selected output to a laser printer. The standard graphics
- printer selection defaults to single page format.
-
- Select Page Format ....
-
- [1] Single Page
- [2] Two Page
- [3] Four Page
-
- Make selection [1, 2 or 3] ? 1
-
- Multiple pages per sheet of paper can be printed. The
- default is single page format.
-
- Select Printer Port...
-
-
-
- Make Selection [lpt1, lpt2 or lpt3] ? lpt1
-
- The printer port is the port that the printer is
- attached to. The possible selections include:
-
- lpt1, lpt2 or lpt3
- - 8 -
-
- Enter the appropriate selection. For a standard DOS
- configuration your printer is located on lpt1. Type in
- your choice, The default is lpt1
-
- Do you wish to have a border? [y/n] y
-
- If you wish to have a border around the page enter y.
-
- If you select n, the header has a line printed to
- separate it from the source listing and a line at the
- bottom of the page.
-
-
- The default is y, or a border is printed.
-
- Do you wish to have a Table of Contents? [y/n] y
-
- If you wish to have a table of contents printed at the
- end of the listing enter y.
-
- If you select n, no table of contents is printer.
-
- The default is y, or the Table of Contents is printed.
-
- Do you wish to have Statistics Printed? [y/n] y
-
- If you wish to have statistics printed enter y.
-
- If you select n, no statistics are printed.
-
- The default is y, or Statistics are printed.
-
- When the parameters have been initialized, the display, Current
- Configuration is displayed.
- - 9 -
-
- 3.2.2 F2 - Continue.
-
- If you select F2, CodeLister will print the source file or files
- in the project list, as you specified in the input parameters.
-
- 3.2.2.1 Display of Files Printed.
-
- As CodeLister prints files, it informs you of the file that is
- being printed, by displaying the message:
- =========================================================================
- Current Configuration
-
- Printer Type - GRAPHICS
- Page Format - Single Page
- Character Style - Normal
- Printer Port - lpt1
- Border - YES
- Table of Contents - YES
- Statistics - YES
-
- CodeLister will print source file: test
- --------------------------------------------------------------------------
-
-
- Printing file "name"
- Printing file "name"
-
- --------------------------------------------------------------------------
- ESC - Abort Printing
- ==========================================================================
- where "name" is the source file.
-
- 3.2.2.2 Stopping the Printing of Files.
-
- If during the printing phase you determine that you must stop
- printing, press Esc. The message:
-
-
-
- Press 'Esc' to stop printing
-
- is displayed. To stop printing, press Esc a second time and you
- will exit CodeLister. If you want to resume printing press any
- key.
-
-
- 3.2.3 F10 - Stop.
-
- Function key F10 allows you to exit from CodeLister without
- printing.
- - 10 -
-
-
- CHAPTER 4 DEFINITION OF LISTINGS
-
-
-
-
- Each page of the listing contains the following sections:
-
- o Header containing:
-
- LISTING OF: This is the name of the file whose source code
- is printed on the page.
-
- EDIT DATE: This is the date that the source file was last
- edited and the source code was saved.
-
- Page the number of the page being printed.
-
- o Source Code Area
-
- This section contains the source code which is printed with
- or without a boarder.
-
- When all of the source code has been printed, he Table of
- Contents and the Statistics are printed, if they were requested
- during the initialization of the configuration parameters.
-
- An example of the Table of Contents is shown:
-
-
- TABLE OF CONTENTS
-
- Function(int a, int b, char *string) .............. 1
- This( void) ........................................ 2
- That (long time) ................................... 3
-
-
- On the left side is the name of the function and its parameters.
- On the right-hand side is the page number that the function is
- defined on.
-
- An example of the Statistics is
-
- Total Size of files (bytes) 3000
- Total number of lines 100
-
- The total number of lines indicates the number of non-blank lines
- found in the source code file. The total size of files, is the
- number of bytes in the files.
- - 11 -
-
-
- CHAPTER 5 ERROR MESSAGES
-
-
-
-
- The following is a list of the error messages that appear if
- CodeLister is unable to perform an action:
-
- 1) CL ERROR: Invalid number of parameters.
-
- You entered an invalid number of command line parameters
- when CL was executed. Example command line parameters are:
-
- clist file.c or clist file
-
- clist -p project.prj or clist -p project
-
- 2) CL ERROR: Cannot open source file 'xxxx.x'
-
- You enter a source file that could not be located. Ensure
- that the file name is spelled correctly and that it exists
- on the specified directory.
-
- 3) CL ERROR: Cannot open project file 'xxxx.prj'
-
- You enter a project file, that could not be located. Ensure
- that the project file name is spelled correctly and that it
- exists on the specified directory.
-
- 4) CL ERROR: Unable to create configuration file.
-
- CodeLister was unable to create the configuration that is
- used to store the default parameter for the printer type,
- printer port. This is probably because the directory that
- the file is to be written to is full.
-
- CodeLister continues with the printing of files, however the
- parameters must be re-entered the next time is run.
-
- 5) CL ERROR: Printer not responding.
-
- CodeLister cannot communicate with your printer. Ensure that
- the printer is either turned on, it is on-line or the
- correct printer port has been selected in configuration
- parameters.
- - 12 -
-
-
-
-
- CHAPTER 6 REGISTRATION AND SUPPORT
-
-
-
-
- If you use this product, please register. To register
- CodeLister, send the registration form complete with $20.00 +
- 4.00 Shipping and Handling (in Canadian dollars) to:
-
- Malcolm D. McDowell
- 85 Halley St
- Nepean Ontario
- K2J 3R5
- Canada
-
- Registration includes:
-
- 1) The latest copy of CodeLister on a master diskette,
- without the registration reminder, on either 5 1/4 or 3 1/2
- floppy.
-
- 2) A printer User's Manual.
-
- 3) Support for 5 months. Support is available weekdays 4-8pm
- (eastern time). A telephone answering machine is available.
- If a message is left, an attempt will be made to answer by
- telephone. If unsuccessful, the response will be by mail.
-
- I can also be reached via Compuserve. My Compuserve ID is:
- 71232,455.
-
- 4) Notification of upgrades.
-
-
-
-
-
- - 13 -
-
-
-
-
- ---- Registration Form for NON CREDIT CARD ORDERS ---
-
-
- Name: __________________________________________________________
-
- Company: _______________________________________________________
-
- Address: _______________________________________________________
-
- ______________________________________________________
-
- State/Province _______________ ZIP/Postal Code: _____________
-
-
-
- Phone: (_____) _______________ Fax: (_____) __________________
-
-
-
-
-
- Type of Diskette for upgrades 5 1/4 ________ or 3 1/2 ______
-
- Number of copies to register:
-
- ________ @ 20.00 per copy ==> ____________
-
- Shipping and Handling ==> 4.00
-
- ------------
-
- Total ==> ____________
-
- Printer(s) Used:
-
- ________________________________________________________________
-
-
- Comments:
-
- - 14 -
-
- --- CREDIT CARD ORDERS ONLY ---
-
- You can order with MC, Visa, Amex, or Discover from Public
- (software) Library by calling 800-2424-PsL or 713-524-6394 or by
- FAX to 713-524-6398 or by CIS Email to 71355,470. You can also
- mail credit card orders to PsL at P.O. Box 35705, Houston, Tx
- 77235-5705.
-
- PLEASE REFER TO PRODUCT NUMBER 10771 WHEN ORDERING.
-
- THE ABOVE NUMBERS ARE FOR ORDERS ONLY.
-
- Any questions about the status of the shipment of the order,
- refunds, registration options, product details, technical
- support, volume discounts, dealer pricing, site licenses,etc,
- must be directed to:
-
- Malcolm D. McDowell
- 85 Halley St.,
- Nepean Ontario
- K2J 3R5
- Canada
-
- (613) 825-8593 (4-8 pm weekdays)
-